gmLog.h File Reference

Declaration of support functions and macros for information logging. More...

#include "gmCoreConfig.h"
#include <QLoggingCategory>

Include dependency graph for gmLog.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	GmLogCategory
	Class representing a category with multiple logging levels. More...
class	GmLogSignalEmitter
	Aux class whose only purpose is to allow loggers to emit a logMessage signal, if configured to do so. More...
class	GmLogIdenter
	RAII object to add an identation level to log messages, reverting the settings when the object is destroyed. More...
class	GmLogIdentClearer
	RAII object to clear the identation level to log messages, restoring to the previous identation when the object is destroyed. More...

Macros
#define	gmLog(category, level, ...)
#define	gmTrace(category, ...)
#define	gmExtInfo(category, ...)
#define	gmInfo(category, ...)
#define	gmWarn(category, ...)
#define	gmError(category, ...)
#define	gmFatal(category, ...)
#define	gmTime(category, ...)
#define	gmMemory(category, ...)
#define	gmLogMsg(category, level, msg)
#define	gmTraceMsg(category, msg)
#define	gmExtInfoMsg(category, msg)
#define	gmInfoMsg(category, msg)
#define	gmWarnMsg(category, msg)
#define	gmErrorMsg(category, msg)
#define	gmFatalMsg(category, msg)
#define	gmTimeMsg(category, msg)
#define	gmMemoryMsg(category, msg)

Enumerations
enum	GmLogLevel {   GM_TRACE , GM_EXT_INFO , GM_INFO , GM_WARNING ,   GM_ERROR , GM_FATAL , GM_TIME , GM_MEMORY ,   GM_COUNT }
	Available log levels list. More...

Functions
GMC_API_EXPORT void	GmLogInit ()
	Initializes the logging facilities.
GMC_API_EXPORT bool	GmSetConsoleLogging (bool mode)
	Enables or disables logging to the console. Returns the previous mode.
GMC_API_EXPORT void	GmSetLogFile (QString logfile, bool flush, const GmLogCategory &logger)
	Enables and configures file logging.
GMC_API_EXPORT void	GmCloseLogFile ()
	Closes the log file if enabled.
GMC_API_EXPORT void	GmFlushLogFile ()
	Flushes the log file if enabled.
GMC_API_EXPORT bool	GmSetShowLoggerName (bool mode)
	Enables or disables showing the logger name before each message. Returns the previous mode.
GMC_API_EXPORT bool	GmSetShowThreadId (bool mode)
	Enables or disables showing the thread id before each message. Returns the previous mode.
GMC_API_EXPORT bool	GmSetHideRepeatedWarnings (bool mode)
	Enables or disables skipping repeated warning messages. Returns the previous mode.
GMC_API_EXPORT void	GmSetLogLevels (const QList< QPair< QString, bool > > &rules)
	Load a new set of logging rules from a rules list. Adds the no qt rules option on top of the given ones.
GMC_API_EXPORT void	GmSetLogLevels (LuaTable &tab, const QList< QPair< QString, bool > > &extraRules, const GmLogCategory &logger)
	Load a new set of logging rules from table tab, using logger to emmit warnings in case of errors on the table.
GMC_API_EXPORT bool	GmLoggerDecorations (void)
	Returns the current logger decoration mode. When set to true, code logging value tables should add decorations to aid regression tests.
GMC_API_EXPORT bool	GmSetLoggerDecorations (bool mode)
	Updates the current logger decoration mode. Returns the previous mode.
GMC_API_EXPORT bool	GmSetStringListLogging (bool mode, QStringList *targetList=NULL)
	Enables or disables logging to a string list. This is useful for capturing messages for testing purposes.
GMC_API_EXPORT const QStringList &	GmLogStringList ()
	Returns the logging string list (has contents only if GmSetStringListLogging(true) was called before)
GMC_API_EXPORT const QObject *	GmSetLoggingSignal (bool enable)
	Enables or disables logging to the logMessage signal. Returns the object that will be used to emit the signal.
GMC_API_EXPORT void	GmLogWrappedMsg (const GmLogCategory &logger, GmLogLevel level, const QString &msg, int maxSize=120, int maxBreak=30)
	Logs the given message breaking lines bigger than maxSize. Message breaking is preferentially done on spaces but can end up being done anywhere if there is no space in the last maxBreak characters.
GMC_API_EXPORT void	GmLogIdent (int offset)
	Changes the current identation level.
GMC_API_EXPORT int	GmLogIdentClear ()
	Clears the current identation level, returning the old one.
GMC_API_EXPORT void	GmLogMemoryUsage (const GmLogCategory &logger, const QString &msg)
	Log the current memory usage and the difference from the last call to GmLogMemoryUsage that printed something (on the first call, gives the difference from the amount of memory in use when the memory manager was initialized in the GmLogInit() function.
GMC_API_EXPORT QString	GmLogFormatMemory (size_t s)
	Return a string with the memory size converted to kB, MB or GB, adding the unit to the converted (if needed) value.
GMC_API_EXPORT const GmLogCategory &	GmPanicLogger ()
	Returns the global "panic" logger, usually used to report memory allocation fails deep inside class structures with no easy access to another logger.

Detailed Description

Declaration of support functions and macros for information logging.

Author

Carlos Augusto Teixeira Mendes

Date

october, 2014

Macro Definition Documentation

gmError

#define gmError	(		category,
			... )

Value:

qCDebug((category).qtCategory(GM_ERROR),    __VA_ARGS__)

gmErrorMsg

#define gmErrorMsg	(		category,
			msg )

Value:

qCDebug((category).qtCategory(GM_ERROR),    qPrintable(msg))

gmExtInfo

#define gmExtInfo	(		category,
			... )

Value:

qCDebug((category).qtCategory(GM_EXT_INFO), __VA_ARGS__)

gmExtInfoMsg

#define gmExtInfoMsg	(		category,
			msg )

Value:

qCDebug((category).qtCategory(GM_EXT_INFO), qPrintable(msg))

gmFatal

#define gmFatal	(		category,
			... )

Value:

qCDebug((category).qtCategory(GM_FATAL),    __VA_ARGS__)

gmFatalMsg

#define gmFatalMsg	(		category,
			msg )

Value:

qCDebug((category).qtCategory(GM_FATAL),    qPrintable(msg))

gmInfo

#define gmInfo	(		category,
			... )

Value:

qCDebug((category).qtCategory(GM_INFO),     __VA_ARGS__)

gmInfoMsg

#define gmInfoMsg	(		category,
			msg )

Value:

qCDebug((category).qtCategory(GM_INFO),     qPrintable(msg))

gmLog

#define gmLog	(		category,
			level,
			... )

Value:

qCDebug((category).qtCategory(level), __VA_ARGS__)

gmLogMsg

#define gmLogMsg	(		category,
			level,
			msg )

Value:

qCDebug((category).qtCategory(level), qPrintable(msg))

gmMemory

#define gmMemory	(		category,
			... )

Value:

qCDebug((category).qtCategory(GM_MEMORY),   __VA_ARGS__)

gmMemoryMsg

#define gmMemoryMsg	(		category,
			msg )

Value:

qCDebug((category).qtCategory(GM_MEMORY),   qPrintable(msg))

gmTime

#define gmTime	(		category,
			... )

Value:

qCDebug((category).qtCategory(GM_TIME),     __VA_ARGS__)

gmTimeMsg

#define gmTimeMsg	(		category,
			msg )

Value:

qCDebug((category).qtCategory(GM_TIME),     qPrintable(msg))

gmTrace

#define gmTrace	(		category,
			... )

Value:

qCDebug((category).qtCategory(GM_TRACE),    __VA_ARGS__)

gmTraceMsg

#define gmTraceMsg	(		category,
			msg )

Value:

qCDebug((category).qtCategory(GM_TRACE),    qPrintable(msg))

gmWarn

#define gmWarn	(		category,
			... )

Value:

qCDebug((category).qtCategory(GM_WARNING),  __VA_ARGS__)

gmWarnMsg

#define gmWarnMsg	(		category,
			msg )

Value:

qCDebug((category).qtCategory(GM_WARNING),  qPrintable(msg))

Enumeration Type Documentation

GmLogLevel

enum GmLogLevel

Available log levels list.

Enumerator
GM_TRACE	Trace information to help system debugging. Much more info than you want.
GM_EXT_INFO	Extended information. Probably more than you wanted.
GM_INFO	Information regarding system evolution and config. Should be the "right" level of messages.
GM_WARNING	A warning message reporting something strange but not necessarilly an error.
GM_ERROR	Reporting an error from which the system can continue (maybe not with its total capacity)
GM_FATAL	Reporting a fatal error. The system cannot continue.
GM_TIME	Reporting timing information. New category so as to be easy to disable all timing messages for tests based on diff with a standard file.
GM_MEMORY	Reporting memory information. New category so as to be easy to disable all memory messages for tests based on diff with a standard file.
GM_COUNT	Number of log levels.

Function Documentation

GmSetLogFile()

GMC_API_EXPORT void GmSetLogFile	(	QString	logfile,
		bool	flush,
		const GmLogCategory &	logger )

Enables and configures file logging.

Parameters

logfile	The log file name
flush	Set to true for forcing a flush after each log write
logger	Logger used to report success/problems while opening the log file

GmSetLogLevels()

GMC_API_EXPORT void GmSetLogLevels	(	LuaTable &	tab,
		const QList< QPair< QString, bool > > &	extraRules,
		const GmLogCategory &	logger )

Load a new set of logging rules from table tab, using logger to emmit warnings in case of errors on the table.

The table should be a list following the following syntax example: tab = {{'gema.simLoader.info', true }, {'.trace', false}, {'gema.simLoader.', true }, } Loaded rules are applied on top of the default ruels set in GmLogInit() Extra rules in 'extraRules' are applied on top of the Lua table rules and can be used to override some of those config file options.

GmSetStringListLogging()

GMC_API_EXPORT bool GmSetStringListLogging	(	bool	mode,
		QStringList *	targetList )

Enables or disables logging to a string list. This is useful for capturing messages for testing purposes.

If targetList is different from NULL, the supplied list will be used to store log messages. Otherwise an internal list will be used. This parameter is relevant only when turning list logginng on.

When logging is disabled, if the target list is the internal list, it is also cleared. Returns the previous mode.